home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 April: Mac OS SDK / Dev.CD Apr 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / Serial.p < prev    next >
Encoding:
Text File  |  1998-02-12  |  9.2 KB  |  252 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Serial.p
  3.  
  4.      Contains:    Asynchronous Serial Driver (.AIn/.AOut/.BIn/.BOut) Interfaces
  5.  
  6.      Version:    Technology:    System 7.6+
  7.                  Release:    Universal Interfaces 3.1
  8.  
  9.      Copyright:    © 1985-1998 by Apple Computer, Inc., all rights reserved
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT Serial;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __SERIAL__}
  28. {$SETC __SERIAL__ := 1}
  29.  
  30. {$I+}
  31. {$SETC SerialIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __MACTYPES__}
  35. {$I MacTypes.p}
  36. {$ENDC}
  37.  
  38.  
  39. {$PUSH}
  40. {$ALIGN MAC68K}
  41. {$LibExport+}
  42.  
  43.  
  44. CONST
  45.     baud150                        = 763;
  46.     baud300                        = 380;
  47.     baud600                        = 189;
  48.     baud1200                    = 94;
  49.     baud1800                    = 62;
  50.     baud2400                    = 46;
  51.     baud3600                    = 30;
  52.     baud4800                    = 22;
  53.     baud7200                    = 14;
  54.     baud9600                    = 10;
  55.     baud14400                    = 6;
  56.     baud19200                    = 4;
  57.     baud28800                    = 2;
  58.     baud38400                    = 1;
  59.     baud57600                    = 0;
  60.  
  61.     stop10                        = 16384;
  62.     stop15                        = -32768;
  63.     stop20                        = -16384;
  64.  
  65.     noParity                    = 0;
  66.     oddParity                    = 4096;
  67.     evenParity                    = 12288;
  68.  
  69.     data5                        = 0;
  70.     data6                        = 2048;
  71.     data7                        = 1024;
  72.     data8                        = 3072;
  73.  
  74.     aData                        = 6;                            {  channel A data in or out (historical)  }
  75.     aCtl                        = 2;                            {  channel A control (historical)  }
  76.     bData                        = 4;                            {  channel B data in or out (historical)  }
  77.     bCtl                        = 0;                            {  channel B control (historical)  }
  78.  
  79.     dsrEvent                    = 2;                            {  flag for SerShk.evts  }
  80.     riEvent                        = 4;                            {  flag for SerShk.evts  }
  81.     dcdEvent                    = 8;                            {  flag for SerShk.evts  }
  82.     ctsEvent                    = 32;                            {  flag for SerShk.evts  }
  83.     breakEvent                    = 128;                            {  flag for SerShk.evts  }
  84.  
  85.     xOffWasSent                    = 128;                            {  flag for SerStaRec.xOffSent  }
  86.     dtrNegated                    = 64;                            {  flag for SerStaRec.xOffSent  }
  87.     rtsNegated                    = 32;                            {  flag for SerStaRec.xOffSent  }
  88.  
  89.     ainRefNum                    = -6;                            {  serial port A input  }
  90.     aoutRefNum                    = -7;                            {  serial port A output  }
  91.     binRefNum                    = -8;                            {  serial port B input  }
  92.     boutRefNum                    = -9;                            {  serial port B output  }
  93.  
  94.     swOverrunErr                = 1;                            {  serial driver error masks  }
  95.     breakErr                    = 8;                            {  serial driver error masks  }
  96.     parityErr                    = 16;                            {  serial driver error masks  }
  97.     hwOverrunErr                = 32;                            {  serial driver error masks  }
  98.     framingErr                    = 64;                            {  serial driver error masks  }
  99.  
  100.     kOptionPreserveDTR            = 128;                            {  option bit used with Control code 16  }
  101.     kOptionClockX1CTS            = 64;                            {  option bit used with Control code 16  }
  102.  
  103.     kUseCTSOutputFlowControl    = 128;                            {  flag for SerShk.fCTS  }
  104.     kUseDSROutputFlowControl    = 64;                            {  flag for SerShk.fCTS  }
  105.     kUseRTSInputFlowControl        = 128;                            {  flag for SerShk.fDTR  }
  106.     kUseDTRInputFlowControl        = 64;                            {  flag for SerShk.fDTR  }
  107.  
  108.     sPortA                        = 0;                            {  Macintosh modem port  }
  109.     sPortB                        = 1;                            {  Macintosh printer port  }
  110.     sCOM1                        = 2;                            {  RS-232 port COM1  }
  111.     sCOM2                        = 3;                            {  RS-232 port COM2  }
  112.  
  113.  
  114. TYPE
  115.     SPortSel                            = SInt8;
  116. { csCodes for serial driver Control routines }
  117.  
  118. CONST
  119.     kSERDConfiguration            = 8;                            {  program port speed, bits/char, parity, and stop bits  }
  120.     kSERDInputBuffer            = 9;                            {  set buffer for chars received with no read pending  }
  121.     kSERDSerHShake                = 10;                            {  equivalent to SerHShake, largely obsolete  }
  122.     kSERDClearBreak                = 11;                            {  assert break signal on output  }
  123.     kSERDSetBreak                = 12;                            {  negate break state on output  }
  124.     kSERDBaudRate                = 13;                            {  set explicit baud rate, other settings unchanged  }
  125.     kSERDHandshake                = 14;                            {  superset of 10, honors setting of fDTR  }
  126.     kSERDClockMIDI                = 15;                            {  clock externally on CTS with specified multiplier  }
  127.     kSERDMiscOptions            = 16;                            {  select clock source and DTR behavior on close  }
  128.     kSERDAssertDTR                = 17;                            {  assert DTR output  }
  129.     kSERDNegateDTR                = 18;                            {  negate DTR output  }
  130.     kSERDSetPEChar                = 19;                            {  select char to replace chars with invalid parity  }
  131.     kSERDSetPEAltChar            = 20;                            {  select char to replace char that replaces chars with invalid parity  }
  132.     kSERDSetXOffFlag            = 21;                            {  set XOff output flow control (same as receiving XOff)  }
  133.     kSERDClearXOffFlag            = 22;                            {  clear XOff output flow control (same as receiving XOn)  }
  134.     kSERDSendXOn                = 23;                            {  send XOn if input flow control state is XOff  }
  135.     kSERDSendXOnOut                = 24;                            {  send XOn regardless of input flow control state  }
  136.     kSERDSendXOff                = 25;                            {  send XOff if input flow control state is XOn  }
  137.     kSERDSendXOffOut            = 26;                            {  send XOff regardless of input flow control state  }
  138.     kSERDResetChannel            = 27;                            {  reset serial I/O channel hardware  }
  139.     kSERDHandshakeRS232            = 28;                            {  extension of 14, allows full RS-232 hardware handshaking  }
  140.     kSERDStickParity            = 29;                            {  use mark/space parity  }
  141.     kSERDAssertRTS                = 30;                            {  assert RTS output  }
  142.     kSERDNegateRTS                = 31;                            {  negate RTS output  }
  143.     kSERD115KBaud                = 115;                            {  set 115.2K baud data rate  }
  144.     kSERD230KBaud                = 230;                            {  set 230.4K baud data rate  }
  145.  
  146.  
  147. { csCodes for serial driver Status routines }
  148.     kSERDInputCount                = 2;                            {  return characters available (SerGetBuf)  }
  149.     kSERDStatus                    = 8;                            {  return characters available (SerStatus)  }
  150.     kSERDVersion                = 9;                            {  return version number in first byte of csParam  }
  151.     kSERDGetDCD                    = 256;                            {  get instantaneous state of DCD (GPi)  }
  152.  
  153.  
  154.  
  155. TYPE
  156.     SerShkPtr = ^SerShk;
  157.     SerShk = PACKED RECORD
  158.         fXOn:                    Byte;                                    {  XOn/XOff output flow control flag  }
  159.         fCTS:                    Byte;                                    {  hardware output flow control flags  }
  160.         xOn:                    UInt8;                                    {  XOn character  }
  161.         xOff:                    UInt8;                                    {  XOff character  }
  162.         errs:                    Byte;                                    {  errors mask bits  }
  163.         evts:                    Byte;                                    {  event enable mask bits  }
  164.         fInX:                    Byte;                                    {  XOn/XOff input flow control flag  }
  165.         fDTR:                    Byte;                                    {  hardware input flow control flags  }
  166.     END;
  167.  
  168.     SerStaRecPtr = ^SerStaRec;
  169.     SerStaRec = PACKED RECORD
  170.         cumErrs:                Byte;                                    {  errors accumulated since last SerStatus() call  }
  171.         xOffSent:                Byte;                                    {  input (requested to be) held off by xOffWasSent or dtrNegated or rtsNegated  }
  172.         rdPend:                    Byte;                                    {  incomplete read pending in I/O queue  }
  173.         wrPend:                    Byte;                                    {  incomplete write pending in I/O queue  }
  174.         ctsHold:                Byte;                                    {  transmit disabled by hardware handshaking  }
  175.         xOffHold:                Byte;                                    {  transmit disabled by XOn/XOff handshaking  }
  176.         dsrHold:                Byte;                                    {  transmit disabled: external device not ready  }
  177.         modemStatus:            Byte;                                    {  reports modem status according to SerShk.evts  }
  178.     END;
  179.  
  180. {$IFC OLDROUTINENAMES }
  181. { ********************************************************************************************* }
  182. { The following constant names have been retired in favor of standard, more descriptive names.  }
  183. { You can still compile old code by defining OLDROUTINENAMES. There were several constants that }
  184. { were formerly available that have been removed, as they are now regarded as either private or }
  185. { unsupported. We advise that you stop using any constants that are not defined in this file.   }
  186. { ********************************************************************************************* }
  187.  
  188. CONST
  189.     serdOptionClockExternal        = 64;                            {  option bit used with Control code 16  }
  190.     serdOptionPreserveDTR        = 128;                            {  option bit used with Control code 16  }
  191.  
  192. { csCodes for serial driver Control routines }
  193.     serdReset                    = 8;
  194.     serdSetBuf                    = 9;
  195.     serdHShake                    = 10;
  196.     serdClrBrk                    = 11;
  197.     serdSetBrk                    = 12;
  198.     serdSetBaud                    = 13;
  199.     serdHShakeDTR                = 14;
  200.     serdSetMIDI                    = 15;
  201.     serdSetMisc                    = 16;
  202.     serdSetDTR                    = 17;
  203.     serdClrDTR                    = 18;
  204.     serdSetPEChar                = 19;
  205.     serdSetPECharAlternate        = 20;
  206.     serdSetXOff                    = 21;
  207.     serdClrXOff                    = 22;
  208.     serdSendXOnConditional        = 23;
  209.     serdSendXOn                    = 24;
  210.     serdSendXOffConditional        = 25;
  211.     serdSendXOff                = 26;
  212.     serdChannelReset            = 27;
  213.     serdSet230KBaud                = 230;                            {  set 230K baud data rate  }
  214.  
  215.  
  216. { csCodes for serial driver Status routines }
  217.     serdGetBuf                    = 2;
  218.     serdStatus                    = 8;
  219.     serdGetVers                    = 9;
  220.  
  221. {$ENDC}  {OLDROUTINENAMES}
  222.  
  223. {
  224.     The following interfaces are for the legacy high-level serial driver glue in
  225.     the interface libraries of your development system. They merely substitue for
  226.     the corresponding synchronous calls to PBControl and PBStatus.
  227.  
  228.     They have not been updated as the serial driver API has evolved. Take note:
  229.  
  230.         SerHShake does not support hardware input flow control. Use csCode 14.
  231.         SerStatus returns only the first six bytes of SerStaRec (through xOffHold).
  232. }
  233. FUNCTION SerReset(refNum: INTEGER; serConfig: INTEGER): OSErr;
  234. FUNCTION SerSetBuf(refNum: INTEGER; serBPtr: Ptr; serBLen: INTEGER): OSErr;
  235. FUNCTION SerHShake(refNum: INTEGER; {CONST}VAR flags: SerShk): OSErr;
  236. FUNCTION SerSetBrk(refNum: INTEGER): OSErr;
  237. FUNCTION SerClrBrk(refNum: INTEGER): OSErr;
  238. FUNCTION SerGetBuf(refNum: INTEGER; VAR count: LONGINT): OSErr;
  239. FUNCTION SerStatus(refNum: INTEGER; VAR serSta: SerStaRec): OSErr;
  240.  
  241.  
  242. {$ALIGN RESET}
  243. {$POP}
  244.  
  245. {$SETC UsingIncludes := SerialIncludes}
  246.  
  247. {$ENDC} {__SERIAL__}
  248.  
  249. {$IFC NOT UsingIncludes}
  250.  END.
  251. {$ENDC}
  252.